home *** CD-ROM | disk | FTP | other *** search
/ Gamers Delight 2 / Gamers Delight 2.iso / Aminet / game / role / pinfocom_3_0.lha / Docs / pinfo.txt < prev   
Text File  |  1992-10-22  |  13KB  |  397 lines
  1.  
  2.  
  3.  
  4. PINFO(1)                      Contributed Software                     PINFO(1)
  5.  
  6.  
  7. NAME
  8.        pinfo - play Infocom Inc. adventures
  9.  
  10. SYNOPSIS
  11.        pinfo [-aAehoOpstvV] [-c context] [-i indent] [-l lines] [-m margin]
  12.        [-r savefile] [display-flags] [datafile[.dat]]
  13.  
  14. DESCRIPTION
  15.        This program allows most of the popular Infocom text  adventures  to
  16.        be  played on your system. The games must be Standard Series for the
  17.        interpreter to function correctly; see the file INFOTBL.TXT  in  the
  18.        product release for full details on all Infocom games.
  19.  
  20.        The  -h  option will tell you what version of Z-Code Interpreter you
  21.        need for that adventure.  The informational  printing  options  (-h,
  22.        -o,  -O,  -v, and -V) will work with any adventure, but you won't be
  23.        able to actually play any games except for  Standard  Series  adven-
  24.        tures.
  25.  
  26.  
  27. OPTIONS
  28.        The command-line arguments allow for screen customizations, and also
  29.        various forms of cheating and/or debugging.
  30.  
  31.    Informational
  32.        These option will print information on the datafile to  the  screen.
  33.        If  any of these are given the game is not actually played, informa-
  34.        tion is just printed.
  35.  
  36.        Note that all these options except -h and -V will print  information
  37.        that  you  are not supposed to know: examination of this information
  38.        on a game you haven't  solved  could  seriously  detract  from  your
  39.        enjoyment of the game.
  40.  
  41.        -h     print the datafile header
  42.  
  43.        -o     print the object names, attributes and links
  44.  
  45.        -O     print the object tree
  46.  
  47.        -v     print the game vocabulary
  48.  
  49.        -V     verify  the game data file to ensure it hasn't been corrupted
  50.               (to get this same feature while playing use the $verify  com-
  51.               mand)
  52.  
  53.    Game Play
  54.        These  options  affect different aspects of game play.  Some of them
  55.        may definitely be considered  cheating  as  they  print  information
  56.        about the internals of the game as you are playing it.
  57.  
  58.        -a     display modifications to objects' attributes while playing
  59.  
  60.        -A     display value tests of objects' attributes while playing
  61.  
  62.  
  63.  
  64. Revision 3.0                    21 October 1992                               1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PINFO(1)                      Contributed Software                     PINFO(1)
  71.  
  72.  
  73.        -c context
  74.               set  the number of lines of context to keep at the top of the
  75.               screen when paging long output (default is 2)
  76.  
  77.        -e     echo each command before executing
  78.  
  79.        -i indent
  80.               set the number of spaces in the left margin (default  is  0).
  81.               Note  that  only  game  output  text  will be indented; input
  82.               prompts and input will not.
  83.  
  84.        -m margin
  85.               set the number of spaces in the right margin (default is 2)
  86.  
  87.        -p     don't page long output
  88.  
  89.        -P     set the alternate prompt flag (this flag is not used  in  all
  90.               games)
  91.  
  92.        -r savefile
  93.               causes  the  interpreter  to  restore the saved game savefile
  94.               after starting up.
  95.  
  96.        -s     don't print status line
  97.  
  98.        -t     display modifications of the object tree while playing
  99.  
  100.        -T     set the Tandy Licensing flag (this flag is not  used  in  all
  101.               games).   On  some  games  this  causes  printed  text  to be
  102.               slightly different.
  103.  
  104.  
  105. Interpreter Escape
  106.        Some of the above flags and options may also be modified during game
  107.        play via interpreter escapes.  Any command beginning with the escape
  108.        character (normally ``@'') is assumed to be  an  interpreter  escape
  109.        command.   The  current  commands  and their values may be listed by
  110.        giving just  the  escape  character  by  itself.   Current  commands
  111.        include:
  112.  
  113.        attr   Toggles the attribute printing variable (see -a above)
  114.  
  115.        echo   Toggles input line echoing (see -e above)
  116.  
  117.        pager  Toggles paged output mode (see -p above)
  118.  
  119.        prompt Toggles the alternate prompt (see -P above)
  120.  
  121.        status Toggles status line printing (see -s above)
  122.  
  123.        tandy  Toggles the Tandy license flag (see -T above)
  124.  
  125.        xfers  Toggles the object transfer flag (see -t above)
  126.  
  127.  
  128.  
  129.  
  130. Revision 3.0                    21 October 1992                               2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PINFO(1)                      Contributed Software                     PINFO(1)
  137.  
  138.  
  139.        Additional  escape  commands  may  be defined by individual terminal
  140.        interfaces; see below.
  141.  
  142. TERMCAP
  143.        This section gives information  specific  to  the  termcap  terminal
  144.        interface.   This  interface is for use with UNIX machines or others
  145.        with UNIX-compatible termcap or terminfo libraries.  In addition  to
  146.        termcap and terminfo it also supports the termio, termios, and sgtty
  147.        line-discipline libraries.
  148.  
  149.    Options
  150.        These options are in addition to the above, general options:
  151.  
  152.        -C file
  153.               Specifies a file of completion words.  If not given no  words
  154.               are  available  at  startup and any words defined during play
  155.               will not be stored.  Note pinfo must  be  compiled  with  GNU
  156.               Readline support to use this option.
  157.  
  158.        -H file
  159.               specifies a GNU Readline library history file to be used.  If
  160.               not given, history is not stored in a file.  Note pinfo  must
  161.               be compiled with GNU Readline support to use this option.
  162.  
  163.    Subshells
  164.        The TERMCAP version of the interpreter can invoke commands in a sub-
  165.        shell or an interactive subshell in the normal UNIX  fashion:  i.e.,
  166.        if a command's first character is an exclamation mark (bang) (``!'')
  167.        then the remainder of the command is passed verbatim to a  subshell.
  168.        If  there  is no text after the exclamation mark then an interactive
  169.        subshell is invoked.
  170.  
  171.        The value of the environment variable SHELL is used as the subshell,
  172.        or /bin/sh if SHELL doesn't exist or is empty.
  173.  
  174.        See  the  GNU Readline section for an exception when using GNU Read-
  175.        line.
  176.  
  177.    GNU Readline
  178.        The TERMCAP version of the interpreter contains optional support for
  179.        the  GNU  Readline  library.  This library allows input line editing
  180.        and history retrieval, including full incremental searching and csh-
  181.        style  command-line  editing.  By default the key bindings are those
  182.        of GNU Emacs, but the library is fully flexible and can  be  config-
  183.        ured to work in vi mode, or you can roll-your-own bindings.
  184.  
  185.        Because  csh-style  editing  uses  an  exclamation mark as the first
  186.        character for history substitutions, in order to get a subshell com-
  187.        mand (see above) you should escape the exclamation mark with a back-
  188.        slash (``\'') when using the GNU Readline library.  For example:
  189.  
  190.             >\!ls -l
  191.  
  192.        In addition to  the  standard  GNU  Readline  bindings,  the  single
  193.  
  194.  
  195.  
  196. Revision 3.0                    21 October 1992                               3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. PINFO(1)                      Contributed Software                     PINFO(1)
  203.  
  204.  
  205.        character command ?  will cause the interpreter to print the current
  206.        history list to the screen.
  207.  
  208.        See the GNU Readline manual for full details.
  209.  
  210.    Completion
  211.        If the GNU Readline library is being used, then completion is avail-
  212.        able by pressing the TAB key.  A list of all possible completions is
  213.        available by pressing TAB twice in a row.
  214.  
  215.        During normal game play the interpreter maintains a list of possible
  216.        words  to  complete  on.  This list is read in from a file specified
  217.        with -C (above) at startup and written out to that file at  the  end
  218.        of  the  game.   Modifications  to the list are possible via special
  219.        interpreter escape commands (see below).
  220.  
  221.        Filename completion is  available  during  save/restore  processing,
  222.        whenever the interpreter is asking for a filename.
  223.  
  224.    Interpreter Escapes
  225.        Two  new  escape  commands  are  defined  in  addition to the normal
  226.        escapes if pinfo is compiled to use the GNU Readline library.  These
  227.        allow addition and deletion of words in the command completion list.
  228.  
  229.        add <word>
  230.               Add <word>  to  the  completion  list.   Duplicates  are  not
  231.               allowed.
  232.  
  233.        del <word>
  234.               Delete <word> from the completion list.
  235.  
  236.    Environment Variables
  237.        When using the interpreter with TERMCAP support, the following envi-
  238.        ronment variables are used:
  239.  
  240.        SHELL  If set, contains the full path of the users shell.  This pro-
  241.               gram  is  invoked  if  the shell command is typed at the game
  242.               prompt with no arguments.
  243.  
  244.        TERM   This variable contains the terminal type used to display  the
  245.               output.
  246.  
  247.        PI_FLAGS
  248.               This  variable  should  contain  flags which you would always
  249.               like present on the pinfo command line.  Any flags given here
  250.               will be overridden by flags actually on the command line, and
  251.               be the next two variables in the case of -H and -C.
  252.  
  253.        PI_HIST
  254.               Contains the filename of the pinfo history file used with GNU
  255.               Readline support (see above).  Setting -H on the command line
  256.               overrides the value of this variable.
  257.  
  258.  
  259.  
  260.  
  261.  
  262. Revision 3.0                    21 October 1992                               4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. PINFO(1)                      Contributed Software                     PINFO(1)
  269.  
  270.  
  271.        PI_WORD
  272.               Contains the filename of the  pinfo  command-completion  word
  273.               file  used with GNU Readline support (see above).  Setting -C
  274.               on the command line overrides the value of this variable.
  275.  
  276. STREAM
  277.        There are no stream terminal interface specific flags  or  capabili-
  278.        tites.
  279.  
  280. DATAFILES
  281.        Infocom  games  consist  of a datafile and an interpreter which exe-
  282.        cutes the instructions contained in the data file to run  the  game.
  283.        This program is essentially a portable datafile interpreter.
  284.  
  285.        If you have the ``Lost Treasures of Infocom'' package for the IBM or
  286.        Amiga you should have the datafiles readily available on the  disks.
  287.        If  you  have any Infocom game for the Macintosh then when transfer-
  288.        ring the program to your UNIX host be sure to not send the Macintosh
  289.        resource  sections  (i.e.,  don't enable the MacBinary option).  Mac
  290.        Infocom programs sans their resources are the datafiles  needed  for
  291.        use with this program.
  292.  
  293.  
  294. BUGS
  295.        Some  of  the  data files have errors in their vocabulary lists.  If
  296.        the -v option detects such an error it will put square brackets ([])
  297.        around the offending word.  Such a word may not be used in the game,
  298.        since the interpreter will not recognize it.  It actually  can't  be
  299.        used  with  *any*  interpreter,  even  the ones from Infocom itself;
  300.        these are bugs in the data file.
  301.  
  302.  
  303. AUTHORS
  304.        The original source code for this interpreter was the InfoTaskForce
  305.               interpreter, version REV_C.
  306.  
  307.        Paul D. Smith <paul_smith@dg.com>
  308.               Modified  from  ITF  REV_C  to  the  current  version.   Many
  309.               enhancements:  see NEWS in the source distribution for a com-
  310.               plete list of user-visible modifications.
  311.  
  312.        Olaf Barthel <olsen@sourcery.mxm.sub.org>
  313.               Contributed the Amiga terminal interface.
  314.  
  315.        Mike Threepoint <linhart@remus.rutgers.edu>
  316.               Contributed the MS-DOS terminal interface.
  317.  
  318.  
  319. COPYRIGHTS
  320.        This pinfo interpreter is distributed under the GNU  General  Public
  321.        License (see the file COPYING in the source directory).
  322.  
  323.        Infocom,  Inc.  has  gone  out  of business, but the rights to their
  324.        games have been sold (various times!) and are currently still owned.
  325.  
  326.  
  327.  
  328. Revision 3.0                    21 October 1992                               5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. PINFO(1)                      Contributed Software                     PINFO(1)
  335.  
  336.  
  337.        All Infocom games are still protected and as such may not be copied.
  338.  
  339.        Some games released by Infocom have  a  very  restrictive  copyright
  340.        which  states that the game may not be played on any platform except
  341.        that for which it was sold.  Please refer to  the  copyright  notice
  342.        contained in your game to decide whether you will be violating copy-
  343.        right laws before using it with this interpreter.
  344.  
  345.        Now that Lost Treasures is available there is no excuse for not pur-
  346.        chasing  the Infocom games yourself; at about $2.50 to $3.00 a game,
  347.        including tax, shipping, handling, manual, maps, and hints [in  LTOI
  348.        I  only] this is a bargain the likes of which you probably won't see
  349.        again in your lifetime! :-).
  350.  
  351.        Let's all support Mediagenic in their release of Lost Treasures I  &
  352.        II and maybe they'll release the rest of the lost Infocom games.
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. Revision 3.0                    21 October 1992                               6
  395.  
  396.  
  397.